<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     * <a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     * <a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.dbcp;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.ArrayList;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.Iterator;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.List;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.commons.pool.PoolableObjectFactory;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.commons.pool.impl.GenericObjectPool;<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>    /**<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;p&gt;An implementation of a Jakarta-Commons ObjectPool which<a name="line.28"></a>
<FONT color="green">029</FONT>     * tracks JDBC connections and can recover abandoned db connections.<a name="line.29"></a>
<FONT color="green">030</FONT>     * If logAbandoned=true, a stack trace will be printed for any<a name="line.30"></a>
<FONT color="green">031</FONT>     * abandoned db connections recovered.<a name="line.31"></a>
<FONT color="green">032</FONT>     *                                                                        <a name="line.32"></a>
<FONT color="green">033</FONT>     * @author Glenn L. Nielsen<a name="line.33"></a>
<FONT color="green">034</FONT>     * @version $Revision: 899987 $ $Date: 2010-01-16 11:51:16 -0500 (Sat, 16 Jan 2010) $<a name="line.34"></a>
<FONT color="green">035</FONT>     */<a name="line.35"></a>
<FONT color="green">036</FONT>    public class AbandonedObjectPool extends GenericObjectPool {<a name="line.36"></a>
<FONT color="green">037</FONT>    <a name="line.37"></a>
<FONT color="green">038</FONT>        /** <a name="line.38"></a>
<FONT color="green">039</FONT>         * DBCP AbandonedConfig <a name="line.39"></a>
<FONT color="green">040</FONT>         */<a name="line.40"></a>
<FONT color="green">041</FONT>        private final AbandonedConfig config;<a name="line.41"></a>
<FONT color="green">042</FONT>        <a name="line.42"></a>
<FONT color="green">043</FONT>        /**<a name="line.43"></a>
<FONT color="green">044</FONT>         * A list of connections in use<a name="line.44"></a>
<FONT color="green">045</FONT>         */<a name="line.45"></a>
<FONT color="green">046</FONT>        private final List trace = new ArrayList();<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>        /**<a name="line.48"></a>
<FONT color="green">049</FONT>         * Create an ObjectPool which tracks db connections.<a name="line.49"></a>
<FONT color="green">050</FONT>         *<a name="line.50"></a>
<FONT color="green">051</FONT>         * @param factory PoolableObjectFactory used to create this<a name="line.51"></a>
<FONT color="green">052</FONT>         * @param config configuration for abandoned db connections<a name="line.52"></a>
<FONT color="green">053</FONT>         */<a name="line.53"></a>
<FONT color="green">054</FONT>        public AbandonedObjectPool(PoolableObjectFactory factory,<a name="line.54"></a>
<FONT color="green">055</FONT>                                   AbandonedConfig config) {<a name="line.55"></a>
<FONT color="green">056</FONT>            super(factory);<a name="line.56"></a>
<FONT color="green">057</FONT>            this.config = config;<a name="line.57"></a>
<FONT color="green">058</FONT>        }<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>        /**<a name="line.60"></a>
<FONT color="green">061</FONT>         * Get a db connection from the pool.<a name="line.61"></a>
<FONT color="green">062</FONT>         *<a name="line.62"></a>
<FONT color="green">063</FONT>         * If removeAbandoned=true, recovers db connections which<a name="line.63"></a>
<FONT color="green">064</FONT>         * have been idle &gt; removeAbandonedTimeout and<a name="line.64"></a>
<FONT color="green">065</FONT>         * getNumActive() &gt; getMaxActive() - 3 and<a name="line.65"></a>
<FONT color="green">066</FONT>         * getNumIdle() &lt; 2<a name="line.66"></a>
<FONT color="green">067</FONT>         * <a name="line.67"></a>
<FONT color="green">068</FONT>         * @return Object jdbc Connection<a name="line.68"></a>
<FONT color="green">069</FONT>         * @throws Exception if an exception occurs retrieving a <a name="line.69"></a>
<FONT color="green">070</FONT>         * connection from the pool<a name="line.70"></a>
<FONT color="green">071</FONT>         */<a name="line.71"></a>
<FONT color="green">072</FONT>        public Object borrowObject() throws Exception {<a name="line.72"></a>
<FONT color="green">073</FONT>            if (config != null<a name="line.73"></a>
<FONT color="green">074</FONT>                    &amp;&amp; config.getRemoveAbandoned()<a name="line.74"></a>
<FONT color="green">075</FONT>                    &amp;&amp; (getNumIdle() &lt; 2)<a name="line.75"></a>
<FONT color="green">076</FONT>                    &amp;&amp; (getNumActive() &gt; getMaxActive() - 3) ) {<a name="line.76"></a>
<FONT color="green">077</FONT>                removeAbandoned();<a name="line.77"></a>
<FONT color="green">078</FONT>            }<a name="line.78"></a>
<FONT color="green">079</FONT>            Object obj = super.borrowObject();<a name="line.79"></a>
<FONT color="green">080</FONT>            if (obj instanceof AbandonedTrace) {<a name="line.80"></a>
<FONT color="green">081</FONT>                ((AbandonedTrace) obj).setStackTrace();<a name="line.81"></a>
<FONT color="green">082</FONT>            }<a name="line.82"></a>
<FONT color="green">083</FONT>            if (obj != null &amp;&amp; config != null &amp;&amp; config.getRemoveAbandoned()) {<a name="line.83"></a>
<FONT color="green">084</FONT>                synchronized (trace) {<a name="line.84"></a>
<FONT color="green">085</FONT>                    trace.add(obj);<a name="line.85"></a>
<FONT color="green">086</FONT>                }<a name="line.86"></a>
<FONT color="green">087</FONT>            }<a name="line.87"></a>
<FONT color="green">088</FONT>            return obj;<a name="line.88"></a>
<FONT color="green">089</FONT>        }<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>        /**<a name="line.91"></a>
<FONT color="green">092</FONT>         * Return a db connection to the pool.<a name="line.92"></a>
<FONT color="green">093</FONT>         *<a name="line.93"></a>
<FONT color="green">094</FONT>         * @param obj db Connection to return<a name="line.94"></a>
<FONT color="green">095</FONT>         * @throws Exception if an exception occurs returning the connection<a name="line.95"></a>
<FONT color="green">096</FONT>         * to the pool<a name="line.96"></a>
<FONT color="green">097</FONT>         */<a name="line.97"></a>
<FONT color="green">098</FONT>        public void returnObject(Object obj) throws Exception {<a name="line.98"></a>
<FONT color="green">099</FONT>            if (config != null &amp;&amp; config.getRemoveAbandoned()) {<a name="line.99"></a>
<FONT color="green">100</FONT>                synchronized (trace) {<a name="line.100"></a>
<FONT color="green">101</FONT>                    boolean foundObject = trace.remove(obj);<a name="line.101"></a>
<FONT color="green">102</FONT>                    if (!foundObject) {<a name="line.102"></a>
<FONT color="green">103</FONT>                        return; // This connection has already been invalidated.  Stop now.<a name="line.103"></a>
<FONT color="green">104</FONT>                    }<a name="line.104"></a>
<FONT color="green">105</FONT>                }<a name="line.105"></a>
<FONT color="green">106</FONT>            }<a name="line.106"></a>
<FONT color="green">107</FONT>            super.returnObject(obj);<a name="line.107"></a>
<FONT color="green">108</FONT>        }<a name="line.108"></a>
<FONT color="green">109</FONT>    <a name="line.109"></a>
<FONT color="green">110</FONT>        /**<a name="line.110"></a>
<FONT color="green">111</FONT>         * Invalidates an object from the pool.<a name="line.111"></a>
<FONT color="green">112</FONT>         *<a name="line.112"></a>
<FONT color="green">113</FONT>         * @param obj object to be returned<a name="line.113"></a>
<FONT color="green">114</FONT>         * @throws Exception if an exception occurs invalidating the object<a name="line.114"></a>
<FONT color="green">115</FONT>         */<a name="line.115"></a>
<FONT color="green">116</FONT>        public void invalidateObject(Object obj) throws Exception {<a name="line.116"></a>
<FONT color="green">117</FONT>            if (config != null &amp;&amp; config.getRemoveAbandoned()) {<a name="line.117"></a>
<FONT color="green">118</FONT>                synchronized (trace) {<a name="line.118"></a>
<FONT color="green">119</FONT>                    boolean foundObject = trace.remove(obj);<a name="line.119"></a>
<FONT color="green">120</FONT>                    if (!foundObject) {<a name="line.120"></a>
<FONT color="green">121</FONT>                        return; // This connection has already been invalidated.  Stop now.<a name="line.121"></a>
<FONT color="green">122</FONT>                    }<a name="line.122"></a>
<FONT color="green">123</FONT>                }<a name="line.123"></a>
<FONT color="green">124</FONT>            }<a name="line.124"></a>
<FONT color="green">125</FONT>            super.invalidateObject(obj);        <a name="line.125"></a>
<FONT color="green">126</FONT>        }<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>        /**<a name="line.128"></a>
<FONT color="green">129</FONT>         * Recover abandoned db connections which have been idle<a name="line.129"></a>
<FONT color="green">130</FONT>         * greater than the removeAbandonedTimeout.<a name="line.130"></a>
<FONT color="green">131</FONT>         */<a name="line.131"></a>
<FONT color="green">132</FONT>        private void removeAbandoned() {<a name="line.132"></a>
<FONT color="green">133</FONT>            // Generate a list of abandoned connections to remove<a name="line.133"></a>
<FONT color="green">134</FONT>            long now = System.currentTimeMillis();<a name="line.134"></a>
<FONT color="green">135</FONT>            long timeout = now - (config.getRemoveAbandonedTimeout() * 1000);<a name="line.135"></a>
<FONT color="green">136</FONT>            ArrayList remove = new ArrayList();<a name="line.136"></a>
<FONT color="green">137</FONT>            synchronized (trace) {<a name="line.137"></a>
<FONT color="green">138</FONT>                Iterator it = trace.iterator();<a name="line.138"></a>
<FONT color="green">139</FONT>                while (it.hasNext()) {<a name="line.139"></a>
<FONT color="green">140</FONT>                    AbandonedTrace pc = (AbandonedTrace) it.next();<a name="line.140"></a>
<FONT color="green">141</FONT>                    if (pc.getLastUsed() &gt; timeout) {<a name="line.141"></a>
<FONT color="green">142</FONT>                        continue;<a name="line.142"></a>
<FONT color="green">143</FONT>                    }<a name="line.143"></a>
<FONT color="green">144</FONT>                    if (pc.getLastUsed() &gt; 0) {<a name="line.144"></a>
<FONT color="green">145</FONT>                        remove.add(pc);<a name="line.145"></a>
<FONT color="green">146</FONT>                    }<a name="line.146"></a>
<FONT color="green">147</FONT>                }<a name="line.147"></a>
<FONT color="green">148</FONT>            }<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>            // Now remove the abandoned connections<a name="line.150"></a>
<FONT color="green">151</FONT>            Iterator it = remove.iterator();<a name="line.151"></a>
<FONT color="green">152</FONT>            while (it.hasNext()) {<a name="line.152"></a>
<FONT color="green">153</FONT>                AbandonedTrace pc = (AbandonedTrace) it.next();<a name="line.153"></a>
<FONT color="green">154</FONT>                if (config.getLogAbandoned()) {<a name="line.154"></a>
<FONT color="green">155</FONT>                    pc.printStackTrace();<a name="line.155"></a>
<FONT color="green">156</FONT>                }             <a name="line.156"></a>
<FONT color="green">157</FONT>                try {<a name="line.157"></a>
<FONT color="green">158</FONT>                    invalidateObject(pc);<a name="line.158"></a>
<FONT color="green">159</FONT>                } catch (Exception e) {<a name="line.159"></a>
<FONT color="green">160</FONT>                    e.printStackTrace();<a name="line.160"></a>
<FONT color="green">161</FONT>                }<a name="line.161"></a>
<FONT color="green">162</FONT>                <a name="line.162"></a>
<FONT color="green">163</FONT>            }<a name="line.163"></a>
<FONT color="green">164</FONT>        }<a name="line.164"></a>
<FONT color="green">165</FONT>    }<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>




























































</PRE>
</BODY>
</HTML>
